[Workers] Document Wrangler auth profiles#31774
Conversation
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
|
Recommended labels: SummaryThis PR adds user-facing documentation for Wrangler authentication profiles (shipping in Wrangler
Overall, the content is well-structured, provides practical examples (agency multi-client work and staging/production separation), and appropriately flags the beta status. Good work. Issues that need attention before merge1. Grammar typo in - A profile is a named OAuth login that you scope to a chosen set of accounts can bind to a directory.
+ A profile is a named OAuth login that you scope to a chosen set of accounts and bind to a directory.2. Pre-merge dependency: Wrangler version bump 🔴 3. Changelog date confirmation 🔴 4. Consider adding 5. 6. Unchecked documentation checklist item VerdictApprove after addressing items 1–3 (grammar fix, wrangler bump, and date confirmation). The rest are optional suggestions. |
irvinebroque
left a comment
There was a problem hiding this comment.
👏 👏 👏
stamp so you have it, see comments
worth considering calling out in blog too (but not blocking on blog)
|
|
||
| A profile is a named OAuth login that you scope to a chosen set of accounts and bind to a directory. Commands run in that directory, and its subdirectories, use the matching account automatically. | ||
|
|
||
| Use profiles to keep a separate login for each client when working at an agency, or to separate staging and production into different accounts. Pair a profile with an `account_id` in your [Wrangler configuration file](/workers/wrangler/configuration/) so a command cannot reach the wrong account. |
Co-authored-by: Brendan Irvine-Broque <brendanib@gmail.com>
Review
Code ReviewThis code review is in beta and may not always be helpful — use your judgment. No code review issues found. ConventionsChecks PR title, description, and redirect checklist. No convention issues found. Style Guide ReviewWarnings (1)
Suggestions (1)
RedirectsNo missing redirect entries found. CommandsOnly codeowners can run commands. Post a comment with the command to trigger it.
|
| # Wrangler often to regenerate the autogenerated command reference, so exempt | ||
| # it (and its miniflare dependency) from the 24h wait. | ||
| - wrangler | ||
| - miniflare |
There was a problem hiding this comment.
I guess we will need to include transitive dependencies of miniflare too 😅
| - miniflare | |
| - miniflare | |
| - workerd | |
| - @cloudflare/workers-types |
Summary
Adds user-facing documentation for Wrangler authentication profiles (workers-sdk #14200, RFC #14161).
Profiles let you keep separate OAuth logins scoped to specific accounts and bind them to directories, so you can work across multiple Cloudflare accounts without re-running
wrangler login— for example, a separate login per client at an agency, or account-separated staging and production withaccount_idas a failsafe.This PR adds:
/workers/wrangler/profiles/covering when to use profiles, the resolution order, account selection, and the create / activate / switch / list / remove workflow.wrangler authcommand reference (auth create,auth activate,auth deactivate,auth list,auth delete) under theauthsection incommands/general.mdx. These autogenerate from the installedwranglerpackage viaexperimental_getWranglerCommands()— including the--profileglobal flag and the "Experimental" badge.To populate the autogenerated command reference, this PR bumps the
wranglerdevDependency to4.106.0(the release that ships profiles). Because that version was published within the repo's 24-hourminimumReleaseAgewindow,wranglerand itsminiflaredependency are added tominimumReleaseAgeExcludeinpnpm-workspace.yaml— the docs site bumps Wrangler frequently to regenerate command docs, so exempting these first-party packages from the age wait is intentional.A full local build passes (8,550 pages), and the guide's per-command anchors (
#auth-create, etc.) resolve against the autogenerated headings.Documentation checklist